Workbook Class

Definition

Namespace: Independentsoft.Office.Spreadsheet
Assembly: Independentsoft.Calc (in Independentsoft.Calc.dll) Version: 3.0.520.1+c6c593d5629a051e0af021b238c5d69d764f9686
C#
public class Workbook : OfficeDocument
Inheritance
Object    OfficeDocument    Workbook

Constructors

WorkbookInitializes a new instance of the Workbook class
Workbook(Stream)Initializes a new instance of the Workbook class
Workbook(String)Initializes a new instance of the Workbook class

Properties

AllowPng 
AllowRefreshQuery 
ApplicationName Gets or sets the name of the application that created the document.
(Inherited from OfficeDocument)
ApplicationVersion Gets or sets the version of the application that created the document.
(Inherited from OfficeDocument)
AutoCompressPictures 
AutoRecovery 
BuildVersion 
CalculateOnSave 
CalculationChains 
CalculationCompleted 
CalculationID 
CalculationIteration 
CalculationMode 
Category Gets or sets the category of the document. Example values for this property might include: Resume, Letter, Technical Presentation, and so on.
(Inherited from OfficeDocument)
CharacterCount Gets or sets the total number of characters in the document.
(Inherited from OfficeDocument)
CheckCompatibilityOnSave 
CodeName 
CodePage 
Company Gets or sets the name of a company associated with the document.
(Inherited from OfficeDocument)
ConcurrentCalculations 
ConcurrentThreadManualCount 
Connections 
ContentStatus Gets or sets status of the content. Example values for this property might include: "Draft", "Reviewed", "Final", and so on.
(Inherited from OfficeDocument)
ContentType Gets or sets type of content represented, generally defined by a specific use and intended audience. This property is distinct from MIME content types as defined in RFC 2616.
(Inherited from OfficeDocument)
ContentTypeTable Gets content types table.
(Inherited from OfficeDocument)
CrashSave 
CreateBackupFile 
Created Gets or sets date and time of creation of the document.
(Inherited from OfficeDocument)
Creator Gets or sets entity primarily responsible for making the content of the document.
(Inherited from OfficeDocument)
CustomFileTable Gets table with documents custom files. It allows you to add files to the document and save them together with document.
(Inherited from OfficeDocument)
CustomProperties
(Inherited from OfficeDocument)
CustomWorkbookViews 
DataExtractLoad 
Date1904 
DefaultThemeVersion 
DefinedNames 
Description Gets or sets explanation of the content of the document.
(Inherited from OfficeDocument)
DigitalSignature Gets or sets the signature of a digitally signed document.
(Inherited from OfficeDocument)
DocumentSecurity Gets or sets the security level of the document as a numeric value.
(Inherited from OfficeDocument)
Dpi 
EmbedSmartTags 
EnableLongFileNames 
EnableScaling Indicates the display mode of the document thumbnail. Set this element to TRUE to enable scaling of the document thumbnail to the display. Set this element to FALSE to enable cropping of the document thumbnail to show only sections that will fit the display.
(Inherited from OfficeDocument)
ExtensionList Gets or sets the workbook's future-feature extension list (extLst element).
ExternalLinks 
FileVersionApplicationName 
FileVersionCodeName 
FilterPrivacy 
ForceFullCalculation 
FullCalculationOnLoad 
FullPrecisionCalculation 
FunctionGroups 
HeadingPairs Gets or sets heading pairs. Heading pairs indicates the grouping of document parts and the number of parts in each group. These parts are not document parts but conceptual representations of document sections.
(Inherited from OfficeDocument)
HiddenSlideCount Gets or sets the number of hidden slides in a presentation document.
(Inherited from OfficeDocument)
HidePivotFieldList 
HyperlinkList Gets or sets the set of hyperlinks that were in the document when last saved.
(Inherited from OfficeDocument)
HyperlinksChanged This element specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. The next producer to open this document shall update the hyperlink relationships with the new hyperlinks specified in this part.
(Inherited from OfficeDocument)
Identifier Gets or sets unambiguous reference to the document within a given context.
(Inherited from OfficeDocument)
InputFileTable Gets table with all input files. It allows you to get files from the document.
(Inherited from OfficeDocument)
IsMacroEnabled 
IsSharedDocument Indicates if this document is currently shared between multiple producers. If this element is set to TRUE, producers should take care when updating the document.
(Inherited from OfficeDocument)
IsTemplate 
IterationCount 
IterativeCalculationDelta 
Keywords Gets or sets delimited set of keywords to support searching and indexing. This is typically a list of terms that are not available elsewhere in the properties.
(Inherited from OfficeDocument)
Language Gets or sets the language of the intellectual content of the document. RFC 3066 provides guidance on encoding to represent languages.
(Inherited from OfficeDocument)
LastCharacterCount Gets or sets the last count of the number of characters (including spaces) in the document.
(Inherited from OfficeDocument)
LastEditedVersion 
LastModifiedBy Gets or sets user who performed the last modification. Example values for this property might include: A name, email address, employee ID, and so on.
(Inherited from OfficeDocument)
LastPrinted Gets or sets date and time of the last printing.
(Inherited from OfficeDocument)
LineCount Gets or sets the total number of lines in the document.
(Inherited from OfficeDocument)
LinksUpToDate Indicates whether hyperlinks in the document are up-to-date. Set this element to TRUE to indicate that hyperlinks are updated. Set this element to FALSE to indicate that hyperlinks are outdated.
(Inherited from OfficeDocument)
LockRevisions 
LockStructure 
LockWindows 
LowestEditedVersion 
Macro
(Inherited from OfficeDocument)
Manager Gets or sets the name of a supervisor associated with the document.
(Inherited from OfficeDocument)
Modified Gets or sets date and time on which the document was changed.
(Inherited from OfficeDocument)
MultimediaClipCount Gets or sets the total number of sound or video clips that are present in the document.
(Inherited from OfficeDocument)
NoteCount Gets or sets the number of slides in a presentation containing notes.
(Inherited from OfficeDocument)
OleSize Gets or sets the reference to the range used as the OLE size when the workbook is embedded as an OLE object.
OptimizeSharedStrings 
PageCount Gets or sets the total number of pages of the document.
(Inherited from OfficeDocument)
ParagraphCount Gets or sets the total number of paragraphs found in the document.
(Inherited from OfficeDocument)
PartTitles Gets or sets the title of each document.
(Inherited from OfficeDocument)
Password 
PivotCaches 
PresentationFormat Gets or set the intended format for a presentation document.
(Inherited from OfficeDocument)
PromptedSolutions 
PublishItems 
QueryTables 
ReadOnlyRecommended 
ReferenceMode 
RefreshAllConnectionsOnOpen 
RelativeHyperlinkBase Gets or sets the base string used for evaluating relative hyperlinks in this document.
(Inherited from OfficeDocument)
RepairLoad 
Revision Gets or sets the revision number.
(Inherited from OfficeDocument)
RevisionHeaderSet 
RevisionsPassword 
SaveExternalLinkValues 
ScreenSize 
SharedStrings 
SharedUsers 
Sheets 
ShowBorderUnselectedTables 
ShowInkAnnotations 
ShowObjects 
ShowPivotChartFilter 
SmartTagDisplayType 
SmartTagTypes 
Styles 
Subject Gets or sets the topic of the content of the document.
(Inherited from OfficeDocument)
TemplateName Gets or sets name of an external document template containing format and style information used to create the document.
(Inherited from OfficeDocument)
Theme Gets or sets documents themes.
(Inherited from OfficeDocument)
Thicket 
Title Gets or sets the name given to the document.
(Inherited from OfficeDocument)
TotalTime Gets or sets total time the document has been edited. The default time unit is minutes.
(Inherited from OfficeDocument)
UpdateLinksType 
UseCss 
Username 
UseSharedStrings 
Version Gets or sets the version number.
(Inherited from OfficeDocument)
Views 
Vml 
WebPublishingObjects 
WordCount Gets or sets the total number of words of the document.
(Inherited from OfficeDocument)
WorkbookPassword 
XmlMaps 

Methods

Clone 
Equals
(Inherited from Object)
Finalize
(Inherited from Object)
Find(String) Returns all occurrences of the specified text in the whole workbook, including the cells of all worksheets, the comments, the headers, the footers and the text of all shapes. Formulas are not searched.
Find(String, FindOptions) Returns all occurrences of the specified text.
FindElementsT Returns all objects of the specified type, for example all cells, all comments or all shapes, from the whole workbook.
FindElementsT(PredicateT) Returns all objects of the specified type which match the specified condition.
FindElementsT(PredicateT, SearchScope) Returns all objects of the specified type which match the specified condition.
FindFirst(String) Returns the first occurrence of the specified text or null if the text was not found.
FindFirst(String, FindOptions) Returns the first occurrence of the specified text or null if the text was not found.
GetBytes
(Overrides OfficeDocumentGetBytes)
GetCells 
GetCsv Returns the content of all worksheets as comma separated values. Each worksheet is preceded by an empty line and its name, the cells of a row are separated by a comma and the rows are separated by a line break. A field which contains a comma, a quotation mark or a line break is enclosed in quotation marks and an embedded quotation mark is doubled, as specified by RFC 4180.
GetHashCode
(Inherited from Object)
GetHtml Converts the workbook to HTML format. Images are embedded in the document.
GetStream
(Overrides OfficeDocumentGetStream)
GetType
(Inherited from Object)
LoadFromXls(Stream) Loads an XLS workbook from a stream. See LoadFromXls(String).
LoadFromXls(String) Loads an XLS (Microsoft Excel 97-2003 binary, BIFF8) workbook and reconstructs its worksheets and cell values (text, numbers, booleans, errors and formula results) into this Workbook.
MemberwiseClone
(Inherited from Object)
Open(Stream)
(Overrides OfficeDocumentOpen(Stream))
Open(String)
(Overrides OfficeDocumentOpen(String))
Remove Removes the specified sheet, row, cell, comment or run from the collection it belongs to.
Replace(IListString, IListString) Replaces all occurrences of the specified oldText with newText.
Replace(String, Run) Replaces all occurrences of the specified text with a copy of the specified run. A cell which holds plain text is converted into a rich text cell, the text before and after the replaced text keeps its format.
Replace(String, IListRun) Replaces all occurrences of the specified text with copies of the specified runs.
Replace(String, String) Replaces all occurrences of the specified oldText with newText in the whole workbook. The format of the cells and the properties of all runs remain unchanged. Formulas are not changed.
Replace(IListString, IListString, FindOptions) Replaces all occurrences of the specified oldText with newText.
Replace(String, Run, FindOptions) Replaces all occurrences of the specified text with a copy of the specified run.
Replace(String, IListRun, FindOptions) Replaces all occurrences of the specified text with copies of the specified runs.
Replace(String, String, FindOptions) Replaces all occurrences of the specified oldText with newText.
Save(Stream)
(Overrides OfficeDocumentSave(Stream))
Save(String)
(Overrides OfficeDocumentSave(String))
Save(String, Boolean)
(Overrides OfficeDocumentSave(String, Boolean))
SaveAsHtml(Stream) Saves the workbook in HTML format. Images are embedded in the document, so the result is a single self-contained file.
SaveAsHtml(String) Saves the workbook in HTML format.
SaveAsHtml(String, Boolean) Saves the workbook in HTML format.
ToString
(Overrides ObjectToString)
Validate Checks the workbook for the things that stop Excel opening an .xlsx, and returns what it finds. An empty list means nothing known is wrong. This is NOT a schema validator: it knows the invariants this object model can express - a workbook needs a sheet, sheet names are constrained and unique - and nothing beyond them. A workbook that passes here can still be rejected for something only a full implementation of the spec would catch, so keep validating output with an independent reader as well.

See Also